/*
 * Copyright (c) 2011 Norbert Kopcsek
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.modulr.feature {

	import flash.events.Event;

	/**
	 * A FeatureEvent object is dispatched whenever a feature event occurs.
	 *
	 * Possible events are:
	 * - FEATURE_LOADED
	 *
	 * @see org.modulr.feature.Feature
	 * @see org.modulr.feature.FeatureLoader
	 *
	 * @author Norbert Kopcsek
	 */
	public class FeatureEvent extends Event {


		//------------------------------------------------------------------------------
		//
		//   Statics 
		//
		//------------------------------------------------------------------------------

		/**
		 * A feature was loaded.
		 */
		public static const FEATURE_LOADED:String = "featureLoaded";


		//------------------------------------------------------------------------------
		//
		//   Constructor 
		//
		//------------------------------------------------------------------------------

		public function FeatureEvent( type:String, feature:Feature, bubbles:Boolean = false, cancelable:Boolean = false ) {
			super( type, bubbles, cancelable );
			_feature = feature;
		}


		//------------------------------------------------------------------------------
		//
		//   Properties (Getter/Setter) 
		//
		//------------------------------------------------------------------------------

		//--------------------------------------
		// feature 
		//--------------------------------------

		/**
		 * The feature dispatching this event.
		 */
		public function get feature():Feature {
			return _feature;
		}


		//------------------------------------------------------------------------------
		//
		//   Protected fields 
		//
		//------------------------------------------------------------------------------

		/**
		 * @private
		 */
		private var _feature:Feature;


		//------------------------------------------------------------------------------
		//
		//   Overridden methods 
		//
		//------------------------------------------------------------------------------

		/**
		 * @inherit
		 */
		override public function clone():Event {
			return new FeatureEvent( type, feature, bubbles, cancelable );
		}
	}
}

